Blog

Eric Peterson

December 13, 2017

Spread the word


Share your thoughts

We enjoyed bringing you tips for [CommandBox](https://www.ortussolutions.com/blog/category/12-tips-of-commandbox-christmas) and [ContentBox](https://www.ortussolutions.com/blog/category/12-tips-of-contentbox-christmas) last year for the 12 days of Christmas so much that we decided to do it again! This year, I'm happy to show you 12 different modules currently hosted on ForgeBox just waiting to make your life easier. So grab a hot drink and cozy up for the **12 Tips of (ForgeBox) Christmas**.

Hyper

Hyper exists to make your life making network requests easier.

Here's the simplest Hyper example:

1
var res = hyper.get( "https://swapi.co/api/films/7" );

The HyperResponse object returned has a few helpers to make it easy to work with requests, including retrieving the status code, inspecting headers, and deserializing json bodies.

The more complex you get with your HTTP requests, the more Hyper shines. A POST request looks like so:

1
2
3
4
5
var res = hyper.post( "https://swapi.co/api/films", {
    "title" = "The Last Jedi",
    "episode_id" = 8,
    "release_date" = "2018-12-15"
} );

This sends a json body, by default. Need form fields and a custom header?

1
2
3
4
5
6
7
8
var res = hyper
    .asFormFields()
    .withHeaders( { "X-Prerelease-Token" = token } )
    .post( "https://swapi.co/api/films", {
        "title" = "The Last Jedi",
        "episode_id" = 8,
        "release_date" = "2018-12-15"
    } );

While this is a nice syntax improvement over cfhttp, Hyper was built to solve the pain points around writing SDK's like GitHub, Stripe, and Twilio. When working with services like these, there is a handful of boilerplate headers, parameters, or other values you need to set.

Hyper lets you create clients — partially configured instances that pass on their defaults to every request made from them. You create a new client with WireBox (most likely in your config/WireBox.cfc):

1
2
3
4
5
6
7
8
9
map( "GitHubClient" )
    .to( "hyper.models.HyperBuilder" )
    .asSingleton()
    .initWith(
        baseUrl = "https://api.github.com",
        headers = {
            "Authorization" = getSetting( "GITHUB_TOKEN" )
        }
    );

This client can then be injected and used elsewhere in your application:

1
2
3
4
5
6
7
8
9
component {
 
    property name="githubClient" inject="GithubClient";
 
    function getRepos() {
        return githubClient.get( "/user/repos" );
    }
 
}

No more repeating yourself all over the place with the same defaults! And if you need to override a default, just set it as normal. Hyper has a full fluent API to set all the parameters you would need.

So check out the documentation over on ForgeBox and stop rewriting the same cfhttp code over and over again.

Merry Christmas!

Add Your Comment

(1)

Dec 14, 2017 06:56:06 UTC

by Chris Geirman

Impressive! I recall there being many nitnoid issues with json deserialization in CF. I don't recall specific pain points however. Assuming you know what I mean, have you solved for them?

Recent Entries

Into the Box Sessions Round 2 and Team Packs!

Into the Box Sessions Round 2 and Team Packs!

The second round of Into the Box sessions is here, packed with incredible new topics, sessions and expert speakers industry leaders in modern CFML getting us modern content and practices you can use to make your coding experience and projects better, faster and easy and expert-led talks on modern web development, serverless applications, cryptography, UI design, and more.

Maria Jose Herrera
Maria Jose Herrera
February 25, 2025
Building Serverless Functions with BoxLang in AWS Lambda!

Building Serverless Functions with BoxLang in AWS Lambda!

The serverless computing model has revolutionized the way we deploy and manage applications, and with BoxLang, it’s easier than ever to leverage AWS Lambda for efficient, scalable execution of cloud functions. In a recent blog post, Ray Camden explored the process of building and deploying BoxLang functions in AWS Lambda. Let’s take a closer look at how it works!

Maria Jose Herrera
Maria Jose Herrera
February 24, 2025
ColdBox Training: From Hero to Superhero – Master ColdFusion and BoxLang Development

ColdBox Training: From Hero to Superhero – Master ColdFusion and BoxLang Development

Are you ready to take your ColdBox development skills for ColdFusion and BoxLang to the next level? Whether you're new to ColdBox or looking to sharpen your expertise, our ColdBox From Hero to Superhero training is the perfect opportunity to become a ColdFusion and BoxLang powerhouse.

Why Attend?

This hands-on training is designed to help ColdFusion and BoxLang developers level up their ...

Cristobal Escobar
Cristobal Escobar
February 19, 2025